<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>The MongoDB\BSON\Regex class</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="mongodb-bson-objectid.unserialize.html">« MongoDB\BSON\ObjectId::unserialize</a></li>
      <li style="float: right;"><a href="mongodb-bson-regex.construct.html">MongoDB\BSON\Regex::__construct »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="book.bson.html">MongoDB\BSON</a></li>
    <li>The MongoDB\BSON\Regex class</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="class.mongodb-bson-regex" class="reference">

 <h1 class="title">The MongoDB\BSON\Regex class</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.0.0)</p>


  <div class="section" id="mongodb-bson-regex.intro">
   <h2 class="title">简介</h2>
   <p class="para">
    BSON type for a regular expression pattern and optional
    <a href="https://www.mongodb.com/docs/manual/reference/operator/query/regex/#op._S_options" class="link external">&raquo;&nbsp;flags</a>.
   </p>
   <blockquote class="note"><p><strong class="note">注意</strong>: 
    <span class="simpara">
     This BSON type is mainly used when querying the database. Alternatively,
     the
     <a href="https://www.mongodb.com/docs/manual/reference/operator/query/regex" class="link external">&raquo;&nbsp;$regex</a>
     query operator may be used.
    </span>
   </p></blockquote>
  </div>


  <div class="section" id="mongodb-bson-regex.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <div class="ooclass"></div>


    <div class="classsynopsisinfo">
     <span class="modifier">final</span>
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">MongoDB\BSON\Regex</strong>
     </span>

     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.mongodb-bson-regexinterface.html" class="interfacename">MongoDB\BSON\RegexInterface</a></span><span class="oointerface">,  <a href="class.mongodb-bson-type.html" class="interfacename">MongoDB\BSON\Type</a></span><span class="oointerface">,  <a href="class.serializable.html" class="interfacename">Serializable</a></span><span class="oointerface">,  <a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span><span class="oointerface">,  <a href="class.stringable.html" class="interfacename">Stringable</a></span> {</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.construct.html" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flags</code><span class="initializer"> = &quot;&quot;</span></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.getflags.html" class="methodname">getFlags</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.getpattern.html" class="methodname">getPattern</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.jsonserialize.html" class="methodname">jsonSerialize</a></span>(): <span class="type"><a href="language.types.declarations.html#language.types.declarations.mixed" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.serialize.html" class="methodname">serialize</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.tostring.html" class="methodname">__toString</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.unserialize.html" class="methodname">unserialize</a></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span>): <span class="type"><span class="type void">void</span></span></div>

   }</div>


  </div>

  <div class="section">
   <h2 class="title">更新日志</h2>
   <p class="para">
    <table class="doctable informaltable">
     
      <thead>
       <tr>
        <th>版本</th>
        <th>说明</th>
       </tr>

      </thead>

      <tbody class="tbody">
       <tr>
        <td>PECL mongodb 1.12.0</td>
        <td>
         Implements <span class="interfacename"><a href="class.stringable.html" class="interfacename">Stringable</a></span> for PHP 8.0+.
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.3.0</td>
        <td>
         Implements <span class="interfacename"><a href="class.mongodb-bson-regexinterface.html" class="interfacename">MongoDB\BSON\RegexInterface</a></span>.
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.2.0</td>
        <td>
         Implements <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span> and
         <span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>.
        </td>
       </tr>

      </tbody>
     
    </table>

   </p>
  </div>

 </div>

 
 






 






 






 






 






 






 







<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-bson-regex.construct.html">MongoDB\BSON\Regex::__construct</a> — Construct a new Regex</li><li><a href="mongodb-bson-regex.getflags.html">MongoDB\BSON\Regex::getFlags</a> — Returns the Regex's flags</li><li><a href="mongodb-bson-regex.getpattern.html">MongoDB\BSON\Regex::getPattern</a> — Returns the Regex's pattern</li><li><a href="mongodb-bson-regex.jsonserialize.html">MongoDB\BSON\Regex::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="mongodb-bson-regex.serialize.html">MongoDB\BSON\Regex::serialize</a> — Serialize a Regex</li><li><a href="mongodb-bson-regex.tostring.html">MongoDB\BSON\Regex::__toString</a> — Returns the string representation of this Regex</li><li><a href="mongodb-bson-regex.unserialize.html">MongoDB\BSON\Regex::unserialize</a> — Unserialize a Regex</li></ul>
</div>
</div></div></body></html>